Remove non-functional VideoPlayer showControlsWhenPaused prop by danielguillan · Pull Request #1388 · primer/brand

danielguillan · 2026-07-06T16:00:08Z

Summary

showControlsWhenPaused used to control whether VideoPlayer rendered its controls while paused. That behavior was removed in 0.49.0 because hiding/showing the controls changed the player height on play/pause, causing layout shift.

Since the prop has already been non-functional, this PR removes the remaining public API and documentation references instead of reintroducing behavior or keeping a deprecated no-op.

List of notable changes:

Removed showControlsWhenPaused from the VideoPlayer TypeScript prop surface
Removed showControlsWhenPaused from Storybook controls
Removed showControlsWhenPaused from the VideoPlayer docs props table
Updated the changeset to document the prop removal

Steps to test:

Run npm run build:lib.
Run npm run test --workspace=packages/react -- --testPathPatterns="VideoPlayer".
Run npm run check --workspace=packages/react.
Run npm run build:next-docs.
Confirm showControlsWhenPaused is no longer listed in the VideoPlayer docs, Storybook controls, or generated TypeScript declarations.

Supporting resources (related issues, external links, etc):

https://github.com/github/brand-experience/issues/222

Contributor checklist:

All new and existing CI checks pass
Tests prove that the feature works and covers both happy and unhappy paths
Any drop in coverage, breaking changes or regressions have been documented above
UI Changes contain new visual snapshots (generated by adding update snapshots label to the PR)
All developer debugging and non-functional logging has been removed
Related issues have been referenced in the PR description

Reviewer checklist:

Check that pull request and proposed changes adhere to our contribution guidelines and code of conduct
Check that tests prove the feature works and covers both happy and unhappy paths
Check that there aren't other open Pull Requests for the same update/change

Screenshots:

Not applicable. This removes a non-functional prop from API/docs surfaces only.

changeset-bot · 2026-07-06T16:00:13Z

🦋 Changeset detected

Latest commit: 137bc23

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 8 packages

Name	Type
@primer/react-brand	Patch
@primer/brand-docs	Patch
@primer/brand-css	Patch
@primer/brand-primitives	Patch
@primer/brand-e2e	Patch
@primer/brand-fonts	Patch
@primer/brand-config	Patch
@primer/brand-storybook	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

github-actions · 2026-07-06T16:02:20Z

🟢 No design token changes found

github-actions · 2026-07-06T16:03:41Z

🟢 No unit test coverage changes found

All components and hooks with tests maintain the same coverage as the main branch.

Copilot

Pull request overview

This PR updates the VideoPlayer component to properly support (and type) the showControlsWhenPaused prop, allowing consumers to hide the control bar while paused, and adds Storybook + test coverage around the new behavior.

Changes:

Added showControlsWhenPaused?: boolean to VideoPlayer props with a default of true.
Updated controls bar visibility logic to hide the controls bar when paused if showControlsWhenPaused={false}.
Added Storybook control and new unit tests covering paused vs playing behavior.

Show a summary per file

File	Description
packages/react/src/VideoPlayer/VideoPlayer.tsx	Adds the `showControlsWhenPaused` prop and updates controls-bar rendering logic.
packages/react/src/VideoPlayer/VideoPlayer.test.tsx	Adds tests asserting controls are hidden while paused (but shown while playing) when the prop is `false`.
packages/react/src/VideoPlayer/VideoPlayer.stories.tsx	Adds a Storybook boolean control + default arg for `showControlsWhenPaused`.
.changeset/smart-wolves-pause.md	Adds a changeset entry describing the update.

Review details

Files reviewed: 4/4 changed files
Comments generated: 2
Review effort level: Low

github-actions · 2026-07-06T16:04:01Z

🟢 Bundle size report

Check	Main	Branch	Change
UMD — full bundle (JS)	101.33 kB	101.33 kB	🟢 No change
UMD — full bundle (CSS)	66.82 kB	66.86 kB	⬆️ +38 B (+0.1%)
ESM — full bundle (JS + CSS)	1.51 MB	1.51 MB	✅ -69 B (-0.0%)
ESM — tree-shaken simple (Button)	69.70 kB	69.59 kB	✅ -111 B (-0.2%)
ESM — tree-shaken complex (ActionMenu)	78.48 kB	78.37 kB	✅ -111 B (-0.1%)

github-actions · 2026-07-06T16:08:43Z

🟢 No visual differences found

Our visual comparison tests did not find any differences in the UI.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

danielguillan · 2026-07-07T16:27:40Z

@rezrah I think we could simply remove the prop completely instead of marking it as deprecated, as it hasn't been working since v0.49. Any thoughts?

rezrah · 2026-07-08T10:12:44Z

@rezrah I think we could simply remove the prop completely instead of marking it as deprecated, as it hasn't been working since v0.49. Any thoughts?

Agree, we should just remove it unless we have a 100% working solution for it (no CLS impact).

I'm a bit unclear on whether we need to remove or restore original functionality though, can you confirm? If it's genuinely not needed, let's remove it.

danielguillan · 2026-07-09T13:04:18Z

It is safe to remove since it has been non-functional. There is a temporary solution to work around VideoPlayer limitations for that use case, and https://github.com/github/brand-experience/issues/383 is planned. 👍

Fix VideoPlayer showControlsWhenPaused prop

1164366

Copilot AI review requested due to automatic review settings July 6, 2026 16:00

danielguillan requested a review from a team as a code owner July 6, 2026 16:00

Copilot started reviewing on behalf of danielguillan July 6, 2026 16:00 View session

danielguillan had a problem deploying to github-pages July 6, 2026 16:03 — with GitHub Actions Failure

Copilot AI reviewed Jul 6, 2026

View reviewed changes

Comment thread packages/react/src/VideoPlayer/VideoPlayer.tsx

Comment thread .changeset/smart-wolves-pause.md Outdated

danielguillan temporarily deployed to github-pages July 6, 2026 16:48 — with GitHub Actions Inactive

Update changeset

923cf08

danielguillan temporarily deployed to github-pages July 6, 2026 16:57 — with GitHub Actions Inactive

danielguillan marked this pull request as draft July 6, 2026 17:20

Deprecate prop

983331d

danielguillan changed the title ~~Fix VideoPlayer showControlsWhenPaused prop~~ Deprecate VideoPlayer showControlsWhenPaused prop Jul 7, 2026

Trigger PR refresh

d2ba244

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

danielguillan temporarily deployed to github-pages July 7, 2026 08:02 — with GitHub Actions Inactive

danielguillan marked this pull request as ready for review July 7, 2026 16:17

danielguillan added 3 commits July 9, 2026 14:55

Remove prop

944c257

Update changeset

a352067

cleanup

137bc23

danielguillan changed the title ~~Deprecate VideoPlayer showControlsWhenPaused prop~~ Remove non-functional VideoPlayer showControlsWhenPaused prop Jul 9, 2026

danielguillan requested a review from rezrah July 9, 2026 13:04

danielguillan temporarily deployed to github-pages July 9, 2026 13:07 — with GitHub Actions Inactive

rezrah approved these changes Jul 15, 2026

View reviewed changes

danielguillan merged commit 21c954b into main Jul 16, 2026
16 checks passed

danielguillan deleted the danielguillan/fix-video-player branch July 16, 2026 13:25

primer Bot mentioned this pull request Jul 16, 2026

Release tracking #1403

Merged

github-actions Bot mentioned this pull request Jul 29, 2026

New release available "@primer/react-brand@0.72.0" primer/brand-releases#44

Closed

22 tasks

Navigation Menu

Uh oh!

Remove non-functional VideoPlayer showControlsWhenPaused prop - #1388

Remove non-functional VideoPlayer showControlsWhenPaused prop#1388
danielguillan merged 7 commits into
mainfrom
danielguillan/fix-video-player

danielguillan commented Jul 6, 2026 •

edited

Loading

Uh oh!

changeset-bot Bot commented Jul 6, 2026 •

edited

Loading

Uh oh!

github-actions Bot commented Jul 6, 2026

Uh oh!

github-actions Bot commented Jul 6, 2026 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

github-actions Bot commented Jul 6, 2026 •

edited

Loading

Uh oh!

github-actions Bot commented Jul 6, 2026 •

edited

Loading

Uh oh!

danielguillan commented Jul 7, 2026

Uh oh!

rezrah commented Jul 8, 2026

Uh oh!

danielguillan commented Jul 9, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Uh oh!

Conversation

danielguillan commented Jul 6, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

List of notable changes:

Steps to test:

Supporting resources (related issues, external links, etc):

Contributor checklist:

Reviewer checklist:

Screenshots:

Uh oh!

changeset-bot Bot commented Jul 6, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🦋 Changeset detected

Uh oh!

github-actions Bot commented Jul 6, 2026

🟢 No design token changes found

Uh oh!

github-actions Bot commented Jul 6, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🟢 No unit test coverage changes found

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Review details

Uh oh!

Uh oh!

Uh oh!

github-actions Bot commented Jul 6, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🟢 Bundle size report

Uh oh!

github-actions Bot commented Jul 6, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🟢 No visual differences found

Uh oh!

danielguillan commented Jul 7, 2026

Uh oh!

rezrah commented Jul 8, 2026

Uh oh!

danielguillan commented Jul 9, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

danielguillan commented Jul 6, 2026 •

edited

Loading

changeset-bot Bot commented Jul 6, 2026 •

edited

Loading

github-actions Bot commented Jul 6, 2026 •

edited

Loading

github-actions Bot commented Jul 6, 2026 •

edited

Loading

github-actions Bot commented Jul 6, 2026 •

edited

Loading